Skip to content

chore(clerk-js,shared): Add API methods to manage enterprise connections#8421

Open
LauraBeatris wants to merge 9 commits intomainfrom
laura/add-enterprise-connection-fapi
Open

chore(clerk-js,shared): Add API methods to manage enterprise connections#8421
LauraBeatris wants to merge 9 commits intomainfrom
laura/add-enterprise-connection-fapi

Conversation

@LauraBeatris
Copy link
Copy Markdown
Member

@LauraBeatris LauraBeatris commented Apr 29, 2026

Description

This PR introduces the existing FAPI API methods to manage enterprise connections + create test runs, those will be used in the <ConfigureSSO /> component

We won't create specific public React hooks for those yet, in order to see how it'll be used on our implementation first, and then design a better interface for it later.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@LauraBeatris LauraBeatris self-assigned this Apr 29, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 29, 2026

🦋 Changeset detected

Latest commit: ce26d30

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 20 packages
Name Type
@clerk/clerk-js Minor
@clerk/shared Minor
@clerk/chrome-extension Patch
@clerk/expo Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/expo-passkeys Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/localizations Patch
@clerk/msw Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/react Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/ui Patch
@clerk/vue Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 29, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 1, 2026 1:33am

Request Review

@LauraBeatris LauraBeatris changed the title chore(clerk-js): Add API methods to manage enterprise connections chore(clerk-js,shared): Add API methods to manage enterprise connections Apr 29, 2026
@LauraBeatris LauraBeatris force-pushed the laura/add-enterprise-connection-fapi branch from 060d051 to 9901d81 Compare April 29, 2026 23:10
@LauraBeatris LauraBeatris force-pushed the laura/add-enterprise-connection-fapi branch from 9901d81 to 4980744 Compare April 29, 2026 23:19
@LauraBeatris LauraBeatris force-pushed the laura/add-enterprise-connection-fapi branch from 4980744 to 6370206 Compare April 29, 2026 23:27
@LauraBeatris LauraBeatris marked this pull request as ready for review April 30, 2026 15:06
@LauraBeatris LauraBeatris requested review from a team and iagodahlem April 30, 2026 15:06
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 30, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds APIs, types, and tests for managing "me" enterprise connections and their test runs. Introduces an EnterpriseConnectionTestRun resource with JSON ↔ resource mapping and snapshot serialization. Extends the User resource with create/update/delete enterprise connection endpoints and create/list test-run endpoints (with pagination and status filtering). Adds shared TypeScript types and re-exports, updates a React hook to expose CRUD callbacks and revalidate, and adds a changeset for minor releases.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly summarizes the main change: adding API methods to manage enterprise connections across clerk-js and shared packages.
Description check ✅ Passed The PR description is related to the changeset, explaining that it introduces FAPI API methods for enterprise connection management for use in the ConfigureSSO component.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 30, 2026

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8421

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8421

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8421

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8421

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@8421

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8421

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8421

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8421

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8421

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8421

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8421

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8421

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8421

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8421

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8421

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8421

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8421

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8421

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8421

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8421

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8421

commit: ce26d30

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx (1)

52-75: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use invalidationKey when revalidating.

stableKey is only the prefix, so this invalidates every enterprise-connection cache entry instead of the current user/settings scope. The cache-key helper already exposes invalidationKey for this path, so use that here.

Suggested fix
-  const { queryKey, stableKey, authenticated } = useUserEnterpriseConnectionsCacheKeys({
+  const { queryKey, invalidationKey, stableKey, authenticated } = useUserEnterpriseConnectionsCacheKeys({
     userId: user?.id ?? null,
     withOrganizationAccountLinking,
   });
@@
-    () => queryClient.invalidateQueries({ queryKey: [stableKey] }),
-    [queryClient, stableKey],
+    () => queryClient.invalidateQueries({ queryKey: invalidationKey }),
+    [queryClient, invalidationKey],
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx` around
lines 52 - 75, The revalidate callback currently invalidates using the broader
stableKey which clears all enterprise-connection entries; update the callback in
useUserEnterpriseConnections.tsx to use the more specific invalidationKey from
useUserEnterpriseConnectionsCacheKeys (replace stableKey with invalidationKey in
the invalidateQueries call inside the revalidate function) so that
queryClient.invalidateQueries targets the current user/settings scope instead of
every enterprise-connection entry.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx`:
- Around line 52-75: The revalidate callback currently invalidates using the
broader stableKey which clears all enterprise-connection entries; update the
callback in useUserEnterpriseConnections.tsx to use the more specific
invalidationKey from useUserEnterpriseConnectionsCacheKeys (replace stableKey
with invalidationKey in the invalidateQueries call inside the revalidate
function) so that queryClient.invalidateQueries targets the current
user/settings scope instead of every enterprise-connection entry.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: fe4ba92f-d3af-490b-9d0c-3ee807fac29a

📥 Commits

Reviewing files that changed from the base of the PR and between ff186e5 and ad95b50.

📒 Files selected for processing (10)
  • .changeset/pink-dolls-rush.md
  • packages/clerk-js/src/core/resources/EnterpriseConnectionTestRun.ts
  • packages/clerk-js/src/core/resources/User.ts
  • packages/clerk-js/src/core/resources/__tests__/User.test.ts
  • packages/clerk-js/src/core/resources/internal.ts
  • packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx
  • packages/shared/src/types/enterpriseConnection.ts
  • packages/shared/src/types/enterpriseConnectionTestRun.ts
  • packages/shared/src/types/index.ts
  • packages/shared/src/types/user.ts
✅ Files skipped from review due to trivial changes (4)
  • packages/clerk-js/src/core/resources/internal.ts
  • .changeset/pink-dolls-rush.md
  • packages/shared/src/types/index.ts
  • packages/shared/src/types/enterpriseConnection.ts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants